Skip to content

docs(readme): lead with a pitch, diagram and quick start - #107

Merged
ALikesToCode merged 1 commit into
mainfrom
docs/readme-front-page
Nov 15, 2026
Merged

ALikesToCode merged 1 commit into
mainfrom
docs/readme-front-page

Conversation

@ALikesToCode

Copy link
Copy Markdown
Owner

Rewrites the top of the README so a first-time reader sees what the gateway is, how requests flow through it, and how to run it in about a minute.

  • One-line pitch and a Mermaid diagram of the request path
  • Quick start checked against a fresh environment: /healthz returns 200 and the admin key authenticates
  • Provider list moved into a collapsed block; licence terms stated near the top
  • Feature list and all later sections are unchanged apart from dropping emoji bullets

I confirm I have the right to send this contribution under the terms in CONTRIBUTING.md.

The README opened with a 25-line provider list and a long feature
catalogue, so a first-time reader had to scroll to learn what the
project is or how to run it. The top now states the purpose in one
line, shows the request path as a diagram, and gives a quick start
verified against a fresh environment. The provider list moves into a
collapsed block; the feature list and everything after it is unchanged.
@coderabbitai

coderabbitai Bot commented Nov 15, 2026

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 95466888-0db1-4855-a71f-7c1268398838
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 15, 2026 •

Copy link
Copy Markdown
Codex Review Summary: ✅ Completed

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-15T03:34:03.741015Z a321d2a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: a321d2a2ae

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +33 to +36
export ADMIN_USERNAME=admin ADMIN_API_KEY=choose-a-long-key
export FLASK_SECRET_KEY=change-me JWT_SECRET=change-me-too
export GROQ_API_KEY_1=your-groq-key
python app.py # listens on http://localhost:1400

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Generate unique secrets in the quick-start commands

When a reader copies this quick start and supplies their Groq key, the server starts with publicly known administrator and session-signing secrets: security_config.py accepts these placeholder values, and app.py defaults to binding 0.0.0.0, not just localhost. On a machine with port 1400 reachable, another user can authenticate with choose-a-long-key and make requests charged to the configured provider account. Generate random secrets in the example and reuse the generated admin key in the curl command; explicitly bind the local quick start to loopback as well.

Useful? React with 👍 / 👎.

@ALikesToCode
ALikesToCode merged commit 3ff728e into main Nov 15, 2026
5 of 6 checks passed
@ALikesToCode
ALikesToCode deleted the docs/readme-front-page branch November 15, 2026 03:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant